Package-level declarations

Types

Link copied to clipboard
interface AutoReloadAware

The interface provides the possibility to auto-reload plugin when run in the IDE.

Link copied to clipboard

The interface provides the path to the Java Agent file for the Coroutines library required to enable coroutines debugging.

Link copied to clipboard

By default, the project with the IntelliJ Platform Gradle Plugin applied required the presence of the IntelliJ Platform, referred to later by various tasks, configurations, and extensions. The Custom IntelliJ Platform concept allows using another version, i.e., to run a guest IDE or tests against it. When applying this interface to the task, custom configurations to hold new dependencies defined by type and version (or localPath, if referring to the local IntelliJ Platform instance) are created, as well as a dedicated PrepareSandboxTask task. Configurations, as well as the task preparing sandbox for running and testing the custom IntelliJ Platform (if required), have a random suffix applied to avoid collisions.

Link copied to clipboard

This interface provides tasks a possibility for accessing information about the IntelliJ Platform currently used in the project. The intelliJPlatformConfiguration input property receives a dependency added to the Configurations.INTELLIJ_PLATFORM configuration, which eventually is resolved and lets to access the IntelliJ Platform details such as ProductInfo or the path to the IntelliJ Platform directory.

Link copied to clipboard

The interface provides the dependency on Java Compiler used by Ant tasks. This dependency is required, i.e., for InstrumentCodeTask to properly configure Ant tasks provided by the IntelliJ Platform.

Link copied to clipboard
interface PluginAware

This interface provides information about the currently built plugin. It resolves and parses the final plugin.xml descriptor file, making its details easily accessible.

Link copied to clipboard

The interface provides the path to the IntelliJ Plugin Verifier executable. It is required to have a dependency on the IntelliJ Plugin Verifier added to the project with IntelliJPlatformDependenciesExtension.pluginVerifier dependencies extension.

Link copied to clipboard

The interface which uses a set of various interfaces required for running a guest IDE.

Link copied to clipboard

This interface provides access to the Java Runtime (i.e., JetBrains Runtime) resolved with JavaRuntimePathResolver.

Link copied to clipboard

The interface provides quick access to the sandbox container and specific directories located within it. The path to the sandbox container is obtained using the IntelliJPlatformExtension.sandboxContainer extension property and the type and version of the IntelliJ Platform applied to the project. Paths respect custom IntelliJ Platform when combined with CustomIntelliJPlatformVersionAware.

Link copied to clipboard

An interface used to distinguish between the SandboxAware consumers and producers.

Link copied to clipboard
interface SigningAware

The interface provides the path to the Marketplace ZIP Signer executable. It is required to have a dependency on the Marketplace ZIP Signer added to the project with IntelliJPlatformDependenciesExtension.zipSigner.

Link copied to clipboard

When you develop a plugin, you may want to check how it works in remote development mode, when one machine is running the backend part and another is running a frontend part (JetBrains Client) which connects to the backend.

Link copied to clipboard

Interface used to describe tasks used for running tests, such as a customizable TestIdeTask or PrepareTestTask used for configuring test and keeping it immutable.

Functions

Link copied to clipboard
fun <T : Any> RegularFile.parse(block: PluginBean.() -> T): T
fun <T : Any> Provider<RegularFile>.parse(block: PluginBean.() -> T): Provider<T>

Parses the plugin.xml file and provides access to the PluginBean object through the block.